<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009<a name="line.2"></a>
<FONT color="green">003</FONT>     Ubiquitous Knowledge Processing (UKP) Lab<a name="line.3"></a>
<FONT color="green">004</FONT>     Technische Universitaet Darmstadt<a name="line.4"></a>
<FONT color="green">005</FONT>     All rights reserved.<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.7"></a>
<FONT color="green">008</FONT>     you may not use this file except in compliance with the License.<a name="line.8"></a>
<FONT color="green">009</FONT>     You may obtain a copy of the License at<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<FONT color="green">014</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<FONT color="green">015</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<FONT color="green">016</FONT>     See the License for the specific language governing permissions and<a name="line.16"></a>
<FONT color="green">017</FONT>     limitations under the License.<a name="line.17"></a>
<FONT color="green">018</FONT>     */<a name="line.18"></a>
<FONT color="green">019</FONT>    package org.uimafit.util;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.Collection;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.Iterator;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.List;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.Map;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.uima.cas.CAS;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.uima.cas.CASException;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.uima.cas.FSIterator;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.uima.cas.Type;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.uima.cas.impl.Subiterator;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.uima.cas.text.AnnotationFS;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.uima.cas.text.AnnotationIndex;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.uima.jcas.JCas;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.uima.jcas.cas.FSArray;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.uima.jcas.cas.FSList;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.uima.jcas.cas.TOP;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.apache.uima.jcas.tcas.Annotation;<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>    /**<a name="line.39"></a>
<FONT color="green">040</FONT>     * Utility methods for convenient access to the {@link JCas}.<a name="line.40"></a>
<FONT color="green">041</FONT>     *<a name="line.41"></a>
<FONT color="green">042</FONT>     * @author Richard Eckart de Castilho<a name="line.42"></a>
<FONT color="green">043</FONT>     * @author Philip Ogren<a name="line.43"></a>
<FONT color="green">044</FONT>     * @author Niklas Jakob<a name="line.44"></a>
<FONT color="green">045</FONT>     */<a name="line.45"></a>
<FONT color="green">046</FONT>    public class JCasUtil {<a name="line.46"></a>
<FONT color="green">047</FONT>            /**<a name="line.47"></a>
<FONT color="green">048</FONT>             * Convenience method to iterator over all features structures of a given type.<a name="line.48"></a>
<FONT color="green">049</FONT>             *<a name="line.49"></a>
<FONT color="green">050</FONT>             * @param &lt;T&gt;<a name="line.50"></a>
<FONT color="green">051</FONT>             *            the iteration type.<a name="line.51"></a>
<FONT color="green">052</FONT>             * @param jCas<a name="line.52"></a>
<FONT color="green">053</FONT>             *            a JCas.<a name="line.53"></a>
<FONT color="green">054</FONT>             * @param type<a name="line.54"></a>
<FONT color="green">055</FONT>             *            the type.<a name="line.55"></a>
<FONT color="green">056</FONT>             * @return An iterable.<a name="line.56"></a>
<FONT color="green">057</FONT>             * @see AnnotationIndex#iterator()<a name="line.57"></a>
<FONT color="green">058</FONT>             * @deprecated use {@link #select}<a name="line.58"></a>
<FONT color="green">059</FONT>             */<a name="line.59"></a>
<FONT color="green">060</FONT>            @Deprecated<a name="line.60"></a>
<FONT color="green">061</FONT>            public static &lt;T extends TOP&gt; Iterable&lt;T&gt; iterate(final JCas jCas, final Class&lt;T&gt; type) {<a name="line.61"></a>
<FONT color="green">062</FONT>                    return select(jCas, type);<a name="line.62"></a>
<FONT color="green">063</FONT>            }<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>            /**<a name="line.65"></a>
<FONT color="green">066</FONT>             * Convenience method to iterator over all annotations of a given type occurring within the<a name="line.66"></a>
<FONT color="green">067</FONT>             * scope of a provided annotation.<a name="line.67"></a>
<FONT color="green">068</FONT>             *<a name="line.68"></a>
<FONT color="green">069</FONT>             * @param &lt;T&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>             *            the iteration type.<a name="line.70"></a>
<FONT color="green">071</FONT>             * @param container<a name="line.71"></a>
<FONT color="green">072</FONT>             *            the containing annotation.<a name="line.72"></a>
<FONT color="green">073</FONT>             * @param type<a name="line.73"></a>
<FONT color="green">074</FONT>             *            the type.<a name="line.74"></a>
<FONT color="green">075</FONT>             * @return A iterable.<a name="line.75"></a>
<FONT color="green">076</FONT>             * @see #selectCovered(Class, AnnotationFS)<a name="line.76"></a>
<FONT color="green">077</FONT>             * @deprecated use {@link #selectCovered}<a name="line.77"></a>
<FONT color="green">078</FONT>             */<a name="line.78"></a>
<FONT color="green">079</FONT>            @Deprecated<a name="line.79"></a>
<FONT color="green">080</FONT>            public static &lt;T extends Annotation&gt; Iterable&lt;T&gt; iterate(final Class&lt;T&gt; type,<a name="line.80"></a>
<FONT color="green">081</FONT>                            final Annotation container) {<a name="line.81"></a>
<FONT color="green">082</FONT>                    return selectCovered(type, container);<a name="line.82"></a>
<FONT color="green">083</FONT>            }<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>            /**<a name="line.85"></a>
<FONT color="green">086</FONT>             * Convenience method to iterator over all annotations of a given type occurring within the<a name="line.86"></a>
<FONT color="green">087</FONT>             * scope of a provided annotation.<a name="line.87"></a>
<FONT color="green">088</FONT>             *<a name="line.88"></a>
<FONT color="green">089</FONT>             * @param &lt;T&gt;<a name="line.89"></a>
<FONT color="green">090</FONT>             *            the iteration type.<a name="line.90"></a>
<FONT color="green">091</FONT>             * @param jCas<a name="line.91"></a>
<FONT color="green">092</FONT>             *            a JCas.<a name="line.92"></a>
<FONT color="green">093</FONT>             * @param container<a name="line.93"></a>
<FONT color="green">094</FONT>             *            the containing annotation.<a name="line.94"></a>
<FONT color="green">095</FONT>             * @param type<a name="line.95"></a>
<FONT color="green">096</FONT>             *            the type.<a name="line.96"></a>
<FONT color="green">097</FONT>             * @return A iterable.<a name="line.97"></a>
<FONT color="green">098</FONT>             * @deprecated use {@link #selectCovered}<a name="line.98"></a>
<FONT color="green">099</FONT>             */<a name="line.99"></a>
<FONT color="green">100</FONT>            @Deprecated<a name="line.100"></a>
<FONT color="green">101</FONT>            public static &lt;T extends Annotation&gt; Iterable&lt;T&gt; iterate(final JCas jCas, final Class&lt;T&gt; type,<a name="line.101"></a>
<FONT color="green">102</FONT>                            final Annotation container) {<a name="line.102"></a>
<FONT color="green">103</FONT>                    return selectCovered(jCas, type, container);<a name="line.103"></a>
<FONT color="green">104</FONT>            }<a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>            /**<a name="line.106"></a>
<FONT color="green">107</FONT>             * Convenience method to iterator over all annotations of a given type occurring within the<a name="line.107"></a>
<FONT color="green">108</FONT>             * scope of a provided annotation (sub-iteration).<a name="line.108"></a>
<FONT color="green">109</FONT>             *<a name="line.109"></a>
<FONT color="green">110</FONT>             * @param &lt;T&gt;<a name="line.110"></a>
<FONT color="green">111</FONT>             *            the iteration type.<a name="line.111"></a>
<FONT color="green">112</FONT>             * @param jCas<a name="line.112"></a>
<FONT color="green">113</FONT>             *            a JCas.<a name="line.113"></a>
<FONT color="green">114</FONT>             * @param container<a name="line.114"></a>
<FONT color="green">115</FONT>             *            the containing annotation.<a name="line.115"></a>
<FONT color="green">116</FONT>             * @param type<a name="line.116"></a>
<FONT color="green">117</FONT>             *            the type.<a name="line.117"></a>
<FONT color="green">118</FONT>             * @param ambiguous<a name="line.118"></a>
<FONT color="green">119</FONT>             *            If set to &lt;code&gt;false&lt;/code&gt;, resulting iterator will be unambiguous.<a name="line.119"></a>
<FONT color="green">120</FONT>             * @param strict<a name="line.120"></a>
<FONT color="green">121</FONT>             *            Controls if annotations that overlap to the right are considered in or out.<a name="line.121"></a>
<FONT color="green">122</FONT>             * @return A sub-iterator iterable.<a name="line.122"></a>
<FONT color="green">123</FONT>             * @see AnnotationIndex#subiterator(AnnotationFS, boolean, boolean)<a name="line.123"></a>
<FONT color="green">124</FONT>             */<a name="line.124"></a>
<FONT color="green">125</FONT>            public static &lt;T extends Annotation&gt; Iterable&lt;T&gt; subiterate(final JCas jCas,<a name="line.125"></a>
<FONT color="green">126</FONT>                            final Class&lt;T&gt; type, final Annotation container, final boolean ambiguous,<a name="line.126"></a>
<FONT color="green">127</FONT>                            final boolean strict) {<a name="line.127"></a>
<FONT color="green">128</FONT>                    return new Iterable&lt;T&gt;() {<a name="line.128"></a>
<FONT color="green">129</FONT>                            public Iterator&lt;T&gt; iterator() {<a name="line.129"></a>
<FONT color="green">130</FONT>                                    return JCasUtil.iterator(container, type, ambiguous, strict);<a name="line.130"></a>
<FONT color="green">131</FONT>                            }<a name="line.131"></a>
<FONT color="green">132</FONT>                    };<a name="line.132"></a>
<FONT color="green">133</FONT>            }<a name="line.133"></a>
<FONT color="green">134</FONT>    <a name="line.134"></a>
<FONT color="green">135</FONT>            /**<a name="line.135"></a>
<FONT color="green">136</FONT>             * Get an iterator over the given feature structure type.<a name="line.136"></a>
<FONT color="green">137</FONT>             *<a name="line.137"></a>
<FONT color="green">138</FONT>             * @param &lt;T&gt;<a name="line.138"></a>
<FONT color="green">139</FONT>             *            the JCas type.<a name="line.139"></a>
<FONT color="green">140</FONT>             * @param jCas<a name="line.140"></a>
<FONT color="green">141</FONT>             *            a JCas.<a name="line.141"></a>
<FONT color="green">142</FONT>             * @param type<a name="line.142"></a>
<FONT color="green">143</FONT>             *            a type.<a name="line.143"></a>
<FONT color="green">144</FONT>             * @return a return value.<a name="line.144"></a>
<FONT color="green">145</FONT>             */<a name="line.145"></a>
<FONT color="green">146</FONT>            @SuppressWarnings({ "unchecked", "rawtypes" })<a name="line.146"></a>
<FONT color="green">147</FONT>            public static &lt;T extends TOP&gt; Iterator&lt;T&gt; iterator(JCas jCas, Class&lt;T&gt; type) {<a name="line.147"></a>
<FONT color="green">148</FONT>                    return (FSIterator) jCas.getIndexRepository().getAllIndexedFS(getType(jCas, type));<a name="line.148"></a>
<FONT color="green">149</FONT>            }<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>            /**<a name="line.151"></a>
<FONT color="green">152</FONT>             * Convenience method to get a sub-iterator for the specified type.<a name="line.152"></a>
<FONT color="green">153</FONT>             *<a name="line.153"></a>
<FONT color="green">154</FONT>             * @param &lt;T&gt;<a name="line.154"></a>
<FONT color="green">155</FONT>             *            the iteration type.<a name="line.155"></a>
<FONT color="green">156</FONT>             * @param container<a name="line.156"></a>
<FONT color="green">157</FONT>             *            the containing annotation.<a name="line.157"></a>
<FONT color="green">158</FONT>             * @param type<a name="line.158"></a>
<FONT color="green">159</FONT>             *            the type.<a name="line.159"></a>
<FONT color="green">160</FONT>             * @param ambiguous<a name="line.160"></a>
<FONT color="green">161</FONT>             *            If set to &lt;code&gt;false&lt;/code&gt;, resulting iterator will be unambiguous.<a name="line.161"></a>
<FONT color="green">162</FONT>             * @param strict<a name="line.162"></a>
<FONT color="green">163</FONT>             *            Controls if annotations that overlap to the right are considered in or out.<a name="line.163"></a>
<FONT color="green">164</FONT>             * @return A sub-iterator.<a name="line.164"></a>
<FONT color="green">165</FONT>             */<a name="line.165"></a>
<FONT color="green">166</FONT>            @SuppressWarnings("unchecked")<a name="line.166"></a>
<FONT color="green">167</FONT>            public static &lt;T extends AnnotationFS&gt; Iterator&lt;T&gt; iterator(Annotation container,<a name="line.167"></a>
<FONT color="green">168</FONT>                            Class&lt;T&gt; type, boolean ambiguous, boolean strict) {<a name="line.168"></a>
<FONT color="green">169</FONT>                    CAS cas = container.getCAS();<a name="line.169"></a>
<FONT color="green">170</FONT>                    return ((AnnotationIndex&lt;T&gt;) cas.getAnnotationIndex(CasUtil.getType(cas, type)))<a name="line.170"></a>
<FONT color="green">171</FONT>                                    .subiterator(container, ambiguous, strict);<a name="line.171"></a>
<FONT color="green">172</FONT>            }<a name="line.172"></a>
<FONT color="green">173</FONT>    <a name="line.173"></a>
<FONT color="green">174</FONT>            /**<a name="line.174"></a>
<FONT color="green">175</FONT>             * Get the CAS type for the given JCas wrapper class type.<a name="line.175"></a>
<FONT color="green">176</FONT>             *<a name="line.176"></a>
<FONT color="green">177</FONT>             * @param jCas<a name="line.177"></a>
<FONT color="green">178</FONT>             *            the JCas containing the type system.<a name="line.178"></a>
<FONT color="green">179</FONT>             * @param type<a name="line.179"></a>
<FONT color="green">180</FONT>             *            the JCas wrapper class type.<a name="line.180"></a>
<FONT color="green">181</FONT>             * @return the CAS type.<a name="line.181"></a>
<FONT color="green">182</FONT>             */<a name="line.182"></a>
<FONT color="green">183</FONT>            public static Type getType(JCas jCas, Class&lt;?&gt; type) {<a name="line.183"></a>
<FONT color="green">184</FONT>                    return CasUtil.getType(jCas.getCas(), type);<a name="line.184"></a>
<FONT color="green">185</FONT>            }<a name="line.185"></a>
<FONT color="green">186</FONT>    <a name="line.186"></a>
<FONT color="green">187</FONT>            /**<a name="line.187"></a>
<FONT color="green">188</FONT>             * Get the CAS type for the given JCas wrapper class type making sure it inherits from<a name="line.188"></a>
<FONT color="green">189</FONT>             * {@link Annotation}.<a name="line.189"></a>
<FONT color="green">190</FONT>             *<a name="line.190"></a>
<FONT color="green">191</FONT>             * @param jCas<a name="line.191"></a>
<FONT color="green">192</FONT>             *            the JCas containing the type system.<a name="line.192"></a>
<FONT color="green">193</FONT>             * @param type<a name="line.193"></a>
<FONT color="green">194</FONT>             *            the JCas wrapper class type.<a name="line.194"></a>
<FONT color="green">195</FONT>             * @return the CAS type.<a name="line.195"></a>
<FONT color="green">196</FONT>             */<a name="line.196"></a>
<FONT color="green">197</FONT>            public static Type getAnnotationType(JCas jCas, Class&lt;?&gt; type) {<a name="line.197"></a>
<FONT color="green">198</FONT>                    return CasUtil.getAnnotationType(jCas.getCas(), type);<a name="line.198"></a>
<FONT color="green">199</FONT>            }<a name="line.199"></a>
<FONT color="green">200</FONT>    <a name="line.200"></a>
<FONT color="green">201</FONT>            /**<a name="line.201"></a>
<FONT color="green">202</FONT>             * Convenience method select all feature structure from the given type from an array.<a name="line.202"></a>
<FONT color="green">203</FONT>             *<a name="line.203"></a>
<FONT color="green">204</FONT>             * @param &lt;T&gt;<a name="line.204"></a>
<FONT color="green">205</FONT>             *            the JCas type.<a name="line.205"></a>
<FONT color="green">206</FONT>             * @param array<a name="line.206"></a>
<FONT color="green">207</FONT>             *            a feature structure array.<a name="line.207"></a>
<FONT color="green">208</FONT>             * @param type<a name="line.208"></a>
<FONT color="green">209</FONT>             *            the type.<a name="line.209"></a>
<FONT color="green">210</FONT>             * @return A collection of the selected type.<a name="line.210"></a>
<FONT color="green">211</FONT>             * @see #selectCovered(Class, AnnotationFS)<a name="line.211"></a>
<FONT color="green">212</FONT>             */<a name="line.212"></a>
<FONT color="green">213</FONT>            public static &lt;T extends TOP&gt; Collection&lt;T&gt; select(final FSArray array, final Class&lt;T&gt; type) {<a name="line.213"></a>
<FONT color="green">214</FONT>                    return cast(CasUtil.selectFS(array, CasUtil.getType(array.getCAS(), type.getName())));<a name="line.214"></a>
<FONT color="green">215</FONT>            }<a name="line.215"></a>
<FONT color="green">216</FONT>    <a name="line.216"></a>
<FONT color="green">217</FONT>            /**<a name="line.217"></a>
<FONT color="green">218</FONT>             * Convenience method select all feature structure from the given type from a list.<a name="line.218"></a>
<FONT color="green">219</FONT>             *<a name="line.219"></a>
<FONT color="green">220</FONT>             * @param &lt;T&gt;<a name="line.220"></a>
<FONT color="green">221</FONT>             *            the JCas type.<a name="line.221"></a>
<FONT color="green">222</FONT>             * @param list<a name="line.222"></a>
<FONT color="green">223</FONT>             *            a feature structure list.<a name="line.223"></a>
<FONT color="green">224</FONT>             * @param type<a name="line.224"></a>
<FONT color="green">225</FONT>             *            the type.<a name="line.225"></a>
<FONT color="green">226</FONT>             * @return A collection of the selected type.<a name="line.226"></a>
<FONT color="green">227</FONT>             * @see #selectCovered(Class, AnnotationFS)<a name="line.227"></a>
<FONT color="green">228</FONT>             */<a name="line.228"></a>
<FONT color="green">229</FONT>            public static &lt;T extends TOP&gt; Collection&lt;T&gt; select(final FSList list, final Class&lt;T&gt; type) {<a name="line.229"></a>
<FONT color="green">230</FONT>                    return cast(FSCollectionFactory<a name="line.230"></a>
<FONT color="green">231</FONT>                                    .create(list, CasUtil.getType(list.getCAS(), type.getName())));<a name="line.231"></a>
<FONT color="green">232</FONT>            }<a name="line.232"></a>
<FONT color="green">233</FONT>    <a name="line.233"></a>
<FONT color="green">234</FONT>            /**<a name="line.234"></a>
<FONT color="green">235</FONT>             * Convenience method to iterator over all features structures of a given type.<a name="line.235"></a>
<FONT color="green">236</FONT>             *<a name="line.236"></a>
<FONT color="green">237</FONT>             * @param &lt;T&gt;<a name="line.237"></a>
<FONT color="green">238</FONT>             *            the iteration type.<a name="line.238"></a>
<FONT color="green">239</FONT>             * @param jCas<a name="line.239"></a>
<FONT color="green">240</FONT>             *            the JCas containing the type system.<a name="line.240"></a>
<FONT color="green">241</FONT>             * @param type<a name="line.241"></a>
<FONT color="green">242</FONT>             *            the type.<a name="line.242"></a>
<FONT color="green">243</FONT>             * @return A collection of the selected type.<a name="line.243"></a>
<FONT color="green">244</FONT>             * @see #selectCovered(Class, AnnotationFS)<a name="line.244"></a>
<FONT color="green">245</FONT>             */<a name="line.245"></a>
<FONT color="green">246</FONT>            public static &lt;T extends TOP&gt; Collection&lt;T&gt; select(final JCas jCas, final Class&lt;T&gt; type) {<a name="line.246"></a>
<FONT color="green">247</FONT>                    return cast(CasUtil.selectFS(jCas.getCas(), getType(jCas, type)));<a name="line.247"></a>
<FONT color="green">248</FONT>            }<a name="line.248"></a>
<FONT color="green">249</FONT>    <a name="line.249"></a>
<FONT color="green">250</FONT>            /**<a name="line.250"></a>
<FONT color="green">251</FONT>             * Get a list of annotations of the given annotation type located between two annotations.<a name="line.251"></a>
<FONT color="green">252</FONT>             * Does not use subiterators and does not respect type priorities. Zero-width annotations<a name="line.252"></a>
<FONT color="green">253</FONT>             * what lie on the borders are included in the result, e.g. if the boundary annotations are<a name="line.253"></a>
<FONT color="green">254</FONT>             * [1..2] and [2..3] then an annotation [2..2] is returned. If there is a non-zero overlap<a name="line.254"></a>
<FONT color="green">255</FONT>             * between the boundary annotations, the result is empty. The method properly handles cases<a name="line.255"></a>
<FONT color="green">256</FONT>             * where the second boundary annotations occurs before the first boundary annotation by<a name="line.256"></a>
<FONT color="green">257</FONT>             * switching their roles.<a name="line.257"></a>
<FONT color="green">258</FONT>             *<a name="line.258"></a>
<FONT color="green">259</FONT>             * @param type<a name="line.259"></a>
<FONT color="green">260</FONT>             *            a UIMA type.<a name="line.260"></a>
<FONT color="green">261</FONT>             * @param ann1<a name="line.261"></a>
<FONT color="green">262</FONT>             *            the first boundary annotation.<a name="line.262"></a>
<FONT color="green">263</FONT>             * @param ann2<a name="line.263"></a>
<FONT color="green">264</FONT>             *            the second boundary annotation.<a name="line.264"></a>
<FONT color="green">265</FONT>             * @return a return value.<a name="line.265"></a>
<FONT color="green">266</FONT>             * @see Subiterator<a name="line.266"></a>
<FONT color="green">267</FONT>             */<a name="line.267"></a>
<FONT color="green">268</FONT>            public static &lt;T extends Annotation&gt; List&lt;T&gt; selectBetween(final Class&lt;T&gt; type,<a name="line.268"></a>
<FONT color="green">269</FONT>                             AnnotationFS ann1, AnnotationFS ann2) {<a name="line.269"></a>
<FONT color="green">270</FONT>                    return cast(CasUtil.selectBetween(CasUtil.getType(ann1.getCAS(), type), ann1, ann2));<a name="line.270"></a>
<FONT color="green">271</FONT>            }<a name="line.271"></a>
<FONT color="green">272</FONT>    <a name="line.272"></a>
<FONT color="green">273</FONT>            /**<a name="line.273"></a>
<FONT color="green">274</FONT>             * Get a list of annotations of the given annotation type located between two annotations.<a name="line.274"></a>
<FONT color="green">275</FONT>             * Does not use subiterators and does not respect type priorities. Zero-width annotations<a name="line.275"></a>
<FONT color="green">276</FONT>             * what lie on the borders are included in the result, e.g. if the boundary annotations are<a name="line.276"></a>
<FONT color="green">277</FONT>             * [1..2] and [2..3] then an annotation [2..2] is returned. If there is a non-zero overlap<a name="line.277"></a>
<FONT color="green">278</FONT>             * between the boundary annotations, the result is empty. The method properly handles cases<a name="line.278"></a>
<FONT color="green">279</FONT>             * where the second boundary annotations occurs before the first boundary annotation by<a name="line.279"></a>
<FONT color="green">280</FONT>             * switching their roles.<a name="line.280"></a>
<FONT color="green">281</FONT>             *<a name="line.281"></a>
<FONT color="green">282</FONT>             * @param jCas<a name="line.282"></a>
<FONT color="green">283</FONT>             *            a JCas containing the annotation.<a name="line.283"></a>
<FONT color="green">284</FONT>             * @param type<a name="line.284"></a>
<FONT color="green">285</FONT>             *            a UIMA type.<a name="line.285"></a>
<FONT color="green">286</FONT>             * @param ann1<a name="line.286"></a>
<FONT color="green">287</FONT>             *            the first boundary annotation.<a name="line.287"></a>
<FONT color="green">288</FONT>             * @param ann2<a name="line.288"></a>
<FONT color="green">289</FONT>             *            the second boundary annotation.<a name="line.289"></a>
<FONT color="green">290</FONT>             * @return a return value.<a name="line.290"></a>
<FONT color="green">291</FONT>             * @see Subiterator<a name="line.291"></a>
<FONT color="green">292</FONT>             */<a name="line.292"></a>
<FONT color="green">293</FONT>            public static &lt;T extends Annotation&gt; List&lt;T&gt; selectBetween(JCas jCas, final Class&lt;T&gt; type,<a name="line.293"></a>
<FONT color="green">294</FONT>                             AnnotationFS ann1, AnnotationFS ann2) {<a name="line.294"></a>
<FONT color="green">295</FONT>                    return cast(CasUtil.selectBetween(jCas.getCas(), getType(jCas, type), ann1, ann2));<a name="line.295"></a>
<FONT color="green">296</FONT>            }<a name="line.296"></a>
<FONT color="green">297</FONT>    <a name="line.297"></a>
<FONT color="green">298</FONT>            /**<a name="line.298"></a>
<FONT color="green">299</FONT>             * Get a list of annotations of the given annotation type constrained by a 'covering'<a name="line.299"></a>
<FONT color="green">300</FONT>             * annotation. Iterates over all annotations of the given type to find the covered annotations.<a name="line.300"></a>
<FONT color="green">301</FONT>             * Does not use subiterators.<a name="line.301"></a>
<FONT color="green">302</FONT>             *<a name="line.302"></a>
<FONT color="green">303</FONT>             * @param &lt;T&gt;<a name="line.303"></a>
<FONT color="green">304</FONT>             *            the JCas type.<a name="line.304"></a>
<FONT color="green">305</FONT>             * @param type<a name="line.305"></a>
<FONT color="green">306</FONT>             *            a UIMA type.<a name="line.306"></a>
<FONT color="green">307</FONT>             * @param coveringAnnotation<a name="line.307"></a>
<FONT color="green">308</FONT>             *            the covering annotation.<a name="line.308"></a>
<FONT color="green">309</FONT>             * @return a return value.<a name="line.309"></a>
<FONT color="green">310</FONT>             * @see Subiterator<a name="line.310"></a>
<FONT color="green">311</FONT>             */<a name="line.311"></a>
<FONT color="green">312</FONT>            public static &lt;T extends AnnotationFS&gt; List&lt;T&gt; selectCovered(Class&lt;T&gt; type,<a name="line.312"></a>
<FONT color="green">313</FONT>                            AnnotationFS coveringAnnotation) {<a name="line.313"></a>
<FONT color="green">314</FONT>                    CAS cas = coveringAnnotation.getCAS();<a name="line.314"></a>
<FONT color="green">315</FONT>                    return cast(CasUtil.selectCovered(cas, CasUtil.getType(cas, type), coveringAnnotation));<a name="line.315"></a>
<FONT color="green">316</FONT>            }<a name="line.316"></a>
<FONT color="green">317</FONT>            <a name="line.317"></a>
<FONT color="green">318</FONT>            /**<a name="line.318"></a>
<FONT color="green">319</FONT>             * Get a list of annotations of the given annotation type constrained by a 'covering'<a name="line.319"></a>
<FONT color="green">320</FONT>             * annotation. Iterates over all annotations of the given type to find the covered annotations.<a name="line.320"></a>
<FONT color="green">321</FONT>             * Does not use subiterators.<a name="line.321"></a>
<FONT color="green">322</FONT>             *<a name="line.322"></a>
<FONT color="green">323</FONT>             * @param &lt;T&gt;<a name="line.323"></a>
<FONT color="green">324</FONT>             *            the JCas type.<a name="line.324"></a>
<FONT color="green">325</FONT>             * @param jCas<a name="line.325"></a>
<FONT color="green">326</FONT>             *            a JCas containing the annotation.<a name="line.326"></a>
<FONT color="green">327</FONT>             * @param type<a name="line.327"></a>
<FONT color="green">328</FONT>             *            a UIMA type.<a name="line.328"></a>
<FONT color="green">329</FONT>             * @param coveringAnnotation<a name="line.329"></a>
<FONT color="green">330</FONT>             *            the covering annotation.<a name="line.330"></a>
<FONT color="green">331</FONT>             * @return a return value.<a name="line.331"></a>
<FONT color="green">332</FONT>             * @see Subiterator<a name="line.332"></a>
<FONT color="green">333</FONT>             */<a name="line.333"></a>
<FONT color="green">334</FONT>            public static &lt;T extends Annotation&gt; List&lt;T&gt; selectCovered(JCas jCas, final Class&lt;T&gt; type,<a name="line.334"></a>
<FONT color="green">335</FONT>                            Annotation coveringAnnotation) {<a name="line.335"></a>
<FONT color="green">336</FONT>                    return cast(CasUtil.selectCovered(jCas.getCas(), getType(jCas, type), coveringAnnotation));<a name="line.336"></a>
<FONT color="green">337</FONT>            }<a name="line.337"></a>
<FONT color="green">338</FONT>    <a name="line.338"></a>
<FONT color="green">339</FONT>            /**<a name="line.339"></a>
<FONT color="green">340</FONT>             * Get a list of annotations of the given annotation type constrained by a 'covering'<a name="line.340"></a>
<FONT color="green">341</FONT>             * annotation. Iterates over all annotations of the given type to find the covered annotations.<a name="line.341"></a>
<FONT color="green">342</FONT>             * Does not use subiterators.<a name="line.342"></a>
<FONT color="green">343</FONT>             * &lt;p&gt;<a name="line.343"></a>
<FONT color="green">344</FONT>             * &lt;b&gt;Note:&lt;/b&gt; this is significantly slower than using<a name="line.344"></a>
<FONT color="green">345</FONT>             * {@link #selectCovered(JCas, Class, Annotation)}<a name="line.345"></a>
<FONT color="green">346</FONT>             *<a name="line.346"></a>
<FONT color="green">347</FONT>             * @param &lt;T&gt;<a name="line.347"></a>
<FONT color="green">348</FONT>             *            the JCas type.<a name="line.348"></a>
<FONT color="green">349</FONT>             * @param jCas<a name="line.349"></a>
<FONT color="green">350</FONT>             *            a JCas containing the annotation.<a name="line.350"></a>
<FONT color="green">351</FONT>             * @param type<a name="line.351"></a>
<FONT color="green">352</FONT>             *            a UIMA type.<a name="line.352"></a>
<FONT color="green">353</FONT>             * @param begin<a name="line.353"></a>
<FONT color="green">354</FONT>             *            begin offset.<a name="line.354"></a>
<FONT color="green">355</FONT>             * @param end<a name="line.355"></a>
<FONT color="green">356</FONT>             *            end offset.<a name="line.356"></a>
<FONT color="green">357</FONT>             * @return a return value.<a name="line.357"></a>
<FONT color="green">358</FONT>             */<a name="line.358"></a>
<FONT color="green">359</FONT>            public static &lt;T extends Annotation&gt; List&lt;T&gt; selectCovered(JCas jCas, final Class&lt;T&gt; type,<a name="line.359"></a>
<FONT color="green">360</FONT>                            int begin, int end) {<a name="line.360"></a>
<FONT color="green">361</FONT>                    return cast(CasUtil.selectCovered(jCas.getCas(), getType(jCas, type), begin, end));<a name="line.361"></a>
<FONT color="green">362</FONT>            }<a name="line.362"></a>
<FONT color="green">363</FONT>    <a name="line.363"></a>
<FONT color="green">364</FONT>            /**<a name="line.364"></a>
<FONT color="green">365</FONT>             * Get a list of annotations of the given annotation type constraint by a certain annotation.<a name="line.365"></a>
<FONT color="green">366</FONT>             * Iterates over all annotations to find the covering annotations.<a name="line.366"></a>
<FONT color="green">367</FONT>             *<a name="line.367"></a>
<FONT color="green">368</FONT>             * &lt;p&gt;<a name="line.368"></a>
<FONT color="green">369</FONT>             * &lt;b&gt;Note:&lt;/b&gt; this is &lt;b&gt;REALLY SLOW!&lt;/b&gt; You don't want to use this.<a name="line.369"></a>
<FONT color="green">370</FONT>             *<a name="line.370"></a>
<FONT color="green">371</FONT>             * @param &lt;T&gt;<a name="line.371"></a>
<FONT color="green">372</FONT>             *            the JCas type.<a name="line.372"></a>
<FONT color="green">373</FONT>             * @param jCas<a name="line.373"></a>
<FONT color="green">374</FONT>             *            a CAS.<a name="line.374"></a>
<FONT color="green">375</FONT>             * @param type<a name="line.375"></a>
<FONT color="green">376</FONT>             *            a UIMA type.<a name="line.376"></a>
<FONT color="green">377</FONT>             * @param begin<a name="line.377"></a>
<FONT color="green">378</FONT>             *            begin offset.<a name="line.378"></a>
<FONT color="green">379</FONT>             * @param end<a name="line.379"></a>
<FONT color="green">380</FONT>             *            end offset.<a name="line.380"></a>
<FONT color="green">381</FONT>             * @return a return value.<a name="line.381"></a>
<FONT color="green">382</FONT>             */<a name="line.382"></a>
<FONT color="green">383</FONT>            public static &lt;T extends Annotation&gt; List&lt;T&gt; selectCovering(JCas jCas, Class&lt;T&gt; type,<a name="line.383"></a>
<FONT color="green">384</FONT>                            int begin, int end) {<a name="line.384"></a>
<FONT color="green">385</FONT>    <a name="line.385"></a>
<FONT color="green">386</FONT>                    return cast(CasUtil.selectCovering(jCas.getCas(), getType(jCas, type), begin, end));<a name="line.386"></a>
<FONT color="green">387</FONT>            }<a name="line.387"></a>
<FONT color="green">388</FONT>    <a name="line.388"></a>
<FONT color="green">389</FONT>            /**<a name="line.389"></a>
<FONT color="green">390</FONT>             * Create an index for quickly lookup up the annotations covering a particular annotation. This<a name="line.390"></a>
<FONT color="green">391</FONT>             * is preferable to using {@link #selectCovering(JCas, Class, int, int)} because the overhead of<a name="line.391"></a>
<FONT color="green">392</FONT>             * scanning the CAS occurs only when the index is build. Subsequent lookups to the index are<a name="line.392"></a>
<FONT color="green">393</FONT>             * fast.<a name="line.393"></a>
<FONT color="green">394</FONT>             *<a name="line.394"></a>
<FONT color="green">395</FONT>             * @param &lt;T&gt;<a name="line.395"></a>
<FONT color="green">396</FONT>             *            the JCas type.<a name="line.396"></a>
<FONT color="green">397</FONT>             * @param jCas<a name="line.397"></a>
<FONT color="green">398</FONT>             *            a JCas.<a name="line.398"></a>
<FONT color="green">399</FONT>             * @param type<a name="line.399"></a>
<FONT color="green">400</FONT>             *            type to create the index for - this is used in lookups.<a name="line.400"></a>
<FONT color="green">401</FONT>             * @param coveringType<a name="line.401"></a>
<FONT color="green">402</FONT>             *            type of covering annotations.<a name="line.402"></a>
<FONT color="green">403</FONT>             * @return the index.<a name="line.403"></a>
<FONT color="green">404</FONT>             */<a name="line.404"></a>
<FONT color="green">405</FONT>            public static &lt;T extends Annotation, S extends Annotation&gt; Map&lt;T, Collection&lt;S&gt;&gt; indexCovering(<a name="line.405"></a>
<FONT color="green">406</FONT>                            JCas jCas, Class&lt;T&gt; type, Class&lt;S&gt; coveringType) {<a name="line.406"></a>
<FONT color="green">407</FONT>                    return cast(CasUtil.indexCovering(jCas.getCas(), getType(jCas, type),<a name="line.407"></a>
<FONT color="green">408</FONT>                                    getType(jCas, coveringType)));<a name="line.408"></a>
<FONT color="green">409</FONT>            }<a name="line.409"></a>
<FONT color="green">410</FONT>    <a name="line.410"></a>
<FONT color="green">411</FONT>            /**<a name="line.411"></a>
<FONT color="green">412</FONT>             * Create an index for quickly lookup up the annotations covered by a particular annotation. This<a name="line.412"></a>
<FONT color="green">413</FONT>             * is preferable to using {@link #selectCovered(JCas, Class, int, int)} because the overhead of<a name="line.413"></a>
<FONT color="green">414</FONT>             * scanning the CAS occurs only when the index is build. Subsequent lookups to the index are<a name="line.414"></a>
<FONT color="green">415</FONT>             * fast.<a name="line.415"></a>
<FONT color="green">416</FONT>             *<a name="line.416"></a>
<FONT color="green">417</FONT>             * @param &lt;T&gt;<a name="line.417"></a>
<FONT color="green">418</FONT>             *            the JCas type.<a name="line.418"></a>
<FONT color="green">419</FONT>             * @param jCas<a name="line.419"></a>
<FONT color="green">420</FONT>             *            a JCas.<a name="line.420"></a>
<FONT color="green">421</FONT>             * @param type<a name="line.421"></a>
<FONT color="green">422</FONT>             *            type to create the index for - this is used in lookups.<a name="line.422"></a>
<FONT color="green">423</FONT>             * @param coveredType<a name="line.423"></a>
<FONT color="green">424</FONT>             *            type of covered annotations.<a name="line.424"></a>
<FONT color="green">425</FONT>             * @return the index.<a name="line.425"></a>
<FONT color="green">426</FONT>             */<a name="line.426"></a>
<FONT color="green">427</FONT>            public static &lt;T extends Annotation, S extends Annotation&gt; Map&lt;T, Collection&lt;S&gt;&gt; indexCovered(<a name="line.427"></a>
<FONT color="green">428</FONT>                            JCas jCas, Class&lt;T&gt; type, Class&lt;S&gt; coveredType) {<a name="line.428"></a>
<FONT color="green">429</FONT>                    return cast(CasUtil.indexCovered(jCas.getCas(), getType(jCas, type),<a name="line.429"></a>
<FONT color="green">430</FONT>                                    getType(jCas, coveredType)));<a name="line.430"></a>
<FONT color="green">431</FONT>            }<a name="line.431"></a>
<FONT color="green">432</FONT>    <a name="line.432"></a>
<FONT color="green">433</FONT>            /**<a name="line.433"></a>
<FONT color="green">434</FONT>             * Check if the given annotation contains any annotation of the given type.<a name="line.434"></a>
<FONT color="green">435</FONT>             *<a name="line.435"></a>
<FONT color="green">436</FONT>             * @param jCas<a name="line.436"></a>
<FONT color="green">437</FONT>             *            a JCas containing the annotation.<a name="line.437"></a>
<FONT color="green">438</FONT>             * @param coveringAnnotation<a name="line.438"></a>
<FONT color="green">439</FONT>             *            the covering annotation.<a name="line.439"></a>
<FONT color="green">440</FONT>             * @param type<a name="line.440"></a>
<FONT color="green">441</FONT>             *            a UIMA type.<a name="line.441"></a>
<FONT color="green">442</FONT>             * @return if an annotation of the given type is present.<a name="line.442"></a>
<FONT color="green">443</FONT>             */<a name="line.443"></a>
<FONT color="green">444</FONT>            public static boolean isCovered(JCas jCas, Annotation coveringAnnotation,<a name="line.444"></a>
<FONT color="green">445</FONT>                            Class&lt;? extends Annotation&gt; type) {<a name="line.445"></a>
<FONT color="green">446</FONT>                    return selectCovered(jCas, type, coveringAnnotation).size() &gt; 0;<a name="line.446"></a>
<FONT color="green">447</FONT>            }<a name="line.447"></a>
<FONT color="green">448</FONT>    <a name="line.448"></a>
<FONT color="green">449</FONT>            /**<a name="line.449"></a>
<FONT color="green">450</FONT>             * This method exists simply as a convenience method for unit testing. It is not very efficient<a name="line.450"></a>
<FONT color="green">451</FONT>             * and should not, in general be used outside the context of unit testing.<a name="line.451"></a>
<FONT color="green">452</FONT>             *<a name="line.452"></a>
<FONT color="green">453</FONT>             * @param &lt;T&gt;<a name="line.453"></a>
<FONT color="green">454</FONT>             *            JCas wrapper type.<a name="line.454"></a>
<FONT color="green">455</FONT>             * @param jCas<a name="line.455"></a>
<FONT color="green">456</FONT>             *            a JCas containing the annotation.<a name="line.456"></a>
<FONT color="green">457</FONT>             * @param cls<a name="line.457"></a>
<FONT color="green">458</FONT>             *            a UIMA type.<a name="line.458"></a>
<FONT color="green">459</FONT>             * @param index<a name="line.459"></a>
<FONT color="green">460</FONT>             *            this can be either positive (0 corresponds to the first annotation of a type) or<a name="line.460"></a>
<FONT color="green">461</FONT>             *            negative (-1 corresponds to the last annotation of a type.)<a name="line.461"></a>
<FONT color="green">462</FONT>             * @return an annotation of the given type<a name="line.462"></a>
<FONT color="green">463</FONT>             */<a name="line.463"></a>
<FONT color="green">464</FONT>            @SuppressWarnings("unchecked")<a name="line.464"></a>
<FONT color="green">465</FONT>            public static &lt;T extends TOP&gt; T selectByIndex(JCas jCas, Class&lt;T&gt; cls, int index) {<a name="line.465"></a>
<FONT color="green">466</FONT>                    return (T) CasUtil.selectFSByIndex(jCas.getCas(), getType(jCas, cls), index);<a name="line.466"></a>
<FONT color="green">467</FONT>            }<a name="line.467"></a>
<FONT color="green">468</FONT>    <a name="line.468"></a>
<FONT color="green">469</FONT>            /**<a name="line.469"></a>
<FONT color="green">470</FONT>             * Get the single instance of the specified type from the JCas.<a name="line.470"></a>
<FONT color="green">471</FONT>             *<a name="line.471"></a>
<FONT color="green">472</FONT>             * @param &lt;T&gt;<a name="line.472"></a>
<FONT color="green">473</FONT>             *            JCas wrapper type.<a name="line.473"></a>
<FONT color="green">474</FONT>             * @param jCas<a name="line.474"></a>
<FONT color="green">475</FONT>             *            a JCas containing the annotation.<a name="line.475"></a>
<FONT color="green">476</FONT>             * @param type<a name="line.476"></a>
<FONT color="green">477</FONT>             *            a UIMA type.<a name="line.477"></a>
<FONT color="green">478</FONT>             * @return the single instance of the given type. throws IllegalArgumentException if not exactly<a name="line.478"></a>
<FONT color="green">479</FONT>             *         one instance if the given type is present.<a name="line.479"></a>
<FONT color="green">480</FONT>             */<a name="line.480"></a>
<FONT color="green">481</FONT>            @SuppressWarnings("unchecked")<a name="line.481"></a>
<FONT color="green">482</FONT>            public static &lt;T extends TOP&gt; T selectSingle(JCas jCas, Class&lt;T&gt; type) {<a name="line.482"></a>
<FONT color="green">483</FONT>                    return (T) CasUtil.selectSingle(jCas.getCas(), getType(jCas, type));<a name="line.483"></a>
<FONT color="green">484</FONT>            }<a name="line.484"></a>
<FONT color="green">485</FONT>    <a name="line.485"></a>
<FONT color="green">486</FONT>            /**<a name="line.486"></a>
<FONT color="green">487</FONT>             * Returns the n annotations preceding the given annotation<a name="line.487"></a>
<FONT color="green">488</FONT>             *<a name="line.488"></a>
<FONT color="green">489</FONT>             * @param &lt;T&gt;<a name="line.489"></a>
<FONT color="green">490</FONT>             *            the JCas type.<a name="line.490"></a>
<FONT color="green">491</FONT>             * @param aJCas<a name="line.491"></a>
<FONT color="green">492</FONT>             *            a JCas.<a name="line.492"></a>
<FONT color="green">493</FONT>             * @param aType<a name="line.493"></a>
<FONT color="green">494</FONT>             *            a type.<a name="line.494"></a>
<FONT color="green">495</FONT>             * @param annotation<a name="line.495"></a>
<FONT color="green">496</FONT>             *            anchor annotation<a name="line.496"></a>
<FONT color="green">497</FONT>             * @param count<a name="line.497"></a>
<FONT color="green">498</FONT>             *            number of annotations to collect<a name="line.498"></a>
<FONT color="green">499</FONT>             * @return List of aType annotations preceding anchor annotation<a name="line.499"></a>
<FONT color="green">500</FONT>             */<a name="line.500"></a>
<FONT color="green">501</FONT>            public static &lt;T extends Annotation&gt; List&lt;T&gt; selectPreceding(JCas aJCas, Class&lt;T&gt; aType,<a name="line.501"></a>
<FONT color="green">502</FONT>                            Annotation annotation, int count) {<a name="line.502"></a>
<FONT color="green">503</FONT>                    Type t = getType(aJCas, aType);<a name="line.503"></a>
<FONT color="green">504</FONT>                    return cast(CasUtil.selectPreceding(aJCas.getCas(), t, annotation, count));<a name="line.504"></a>
<FONT color="green">505</FONT>            }<a name="line.505"></a>
<FONT color="green">506</FONT>    <a name="line.506"></a>
<FONT color="green">507</FONT>            /**<a name="line.507"></a>
<FONT color="green">508</FONT>             * Returns the n annotations following the given annotation<a name="line.508"></a>
<FONT color="green">509</FONT>             *<a name="line.509"></a>
<FONT color="green">510</FONT>             * @param &lt;T&gt;<a name="line.510"></a>
<FONT color="green">511</FONT>             *            the JCas type.<a name="line.511"></a>
<FONT color="green">512</FONT>             * @param aJCas<a name="line.512"></a>
<FONT color="green">513</FONT>             *            a JCas.<a name="line.513"></a>
<FONT color="green">514</FONT>             * @param aType<a name="line.514"></a>
<FONT color="green">515</FONT>             *            a type.<a name="line.515"></a>
<FONT color="green">516</FONT>             * @param annotation<a name="line.516"></a>
<FONT color="green">517</FONT>             *            anchor annotation<a name="line.517"></a>
<FONT color="green">518</FONT>             * @param count<a name="line.518"></a>
<FONT color="green">519</FONT>             *            number of annotations to collect<a name="line.519"></a>
<FONT color="green">520</FONT>             * @return List of aType annotations following anchor annotation<a name="line.520"></a>
<FONT color="green">521</FONT>             */<a name="line.521"></a>
<FONT color="green">522</FONT>            public static &lt;T extends Annotation&gt; List&lt;T&gt; selectFollowing(JCas aJCas, Class&lt;T&gt; aType,<a name="line.522"></a>
<FONT color="green">523</FONT>                            Annotation annotation, int count) {<a name="line.523"></a>
<FONT color="green">524</FONT>                    Type t = getType(aJCas, aType);<a name="line.524"></a>
<FONT color="green">525</FONT>                    return cast(CasUtil.selectFollowing(aJCas.getCas(), t, annotation, count));<a name="line.525"></a>
<FONT color="green">526</FONT>            }<a name="line.526"></a>
<FONT color="green">527</FONT>    <a name="line.527"></a>
<FONT color="green">528</FONT>            /**<a name="line.528"></a>
<FONT color="green">529</FONT>             * Test if a JCas contains an annotation of the given type.<a name="line.529"></a>
<FONT color="green">530</FONT>             *<a name="line.530"></a>
<FONT color="green">531</FONT>             * @param &lt;T&gt;<a name="line.531"></a>
<FONT color="green">532</FONT>             *            the annotation type.<a name="line.532"></a>
<FONT color="green">533</FONT>             * @param aJCas<a name="line.533"></a>
<FONT color="green">534</FONT>             *            a JCas.<a name="line.534"></a>
<FONT color="green">535</FONT>             * @param aType<a name="line.535"></a>
<FONT color="green">536</FONT>             *            a annotation class.<a name="line.536"></a>
<FONT color="green">537</FONT>             * @return {@code true} if there is at least one annotation of the given type in the JCas.<a name="line.537"></a>
<FONT color="green">538</FONT>             */<a name="line.538"></a>
<FONT color="green">539</FONT>            public static &lt;T extends TOP&gt; boolean exists(JCas aJCas, Class&lt;T&gt; aType) {<a name="line.539"></a>
<FONT color="green">540</FONT>                    return JCasUtil.iterator(aJCas, aType).hasNext();<a name="line.540"></a>
<FONT color="green">541</FONT>            }<a name="line.541"></a>
<FONT color="green">542</FONT>    <a name="line.542"></a>
<FONT color="green">543</FONT>            /**<a name="line.543"></a>
<FONT color="green">544</FONT>             * Convenience method to get the specified view or a default view if the requested view does not<a name="line.544"></a>
<FONT color="green">545</FONT>             * exist. The default can also be {@code null}.<a name="line.545"></a>
<FONT color="green">546</FONT>             *<a name="line.546"></a>
<FONT color="green">547</FONT>             * @param jcas<a name="line.547"></a>
<FONT color="green">548</FONT>             *            a JCas<a name="line.548"></a>
<FONT color="green">549</FONT>             * @param viewName<a name="line.549"></a>
<FONT color="green">550</FONT>             *            the requested view.<a name="line.550"></a>
<FONT color="green">551</FONT>             * @param fallback<a name="line.551"></a>
<FONT color="green">552</FONT>             *            the default view if the requested view does not exist.<a name="line.552"></a>
<FONT color="green">553</FONT>             * @return the requested view or the default if the requested view does not exist.<a name="line.553"></a>
<FONT color="green">554</FONT>             * @throws IllegalStateException<a name="line.554"></a>
<FONT color="green">555</FONT>             *             if the JCas wrapper cannot be obtained.<a name="line.555"></a>
<FONT color="green">556</FONT>             */<a name="line.556"></a>
<FONT color="green">557</FONT>            public static JCas getView(JCas jcas, String viewName, JCas fallback) {<a name="line.557"></a>
<FONT color="green">558</FONT>                    try {<a name="line.558"></a>
<FONT color="green">559</FONT>                            CAS fallbackCas = fallback != null ? fallback.getCas() : null;<a name="line.559"></a>
<FONT color="green">560</FONT>                            CAS view = CasUtil.getView(jcas.getCas(), viewName, fallbackCas);<a name="line.560"></a>
<FONT color="green">561</FONT>                            return view != null ? view.getJCas() : null;<a name="line.561"></a>
<FONT color="green">562</FONT>                    }<a name="line.562"></a>
<FONT color="green">563</FONT>                    catch (CASException e) {<a name="line.563"></a>
<FONT color="green">564</FONT>                            throw new IllegalStateException(e);<a name="line.564"></a>
<FONT color="green">565</FONT>                    }<a name="line.565"></a>
<FONT color="green">566</FONT>            }<a name="line.566"></a>
<FONT color="green">567</FONT>    <a name="line.567"></a>
<FONT color="green">568</FONT>            /**<a name="line.568"></a>
<FONT color="green">569</FONT>             * Convenience method to get the specified view or create a new view if the requested view does<a name="line.569"></a>
<FONT color="green">570</FONT>             * not exist.<a name="line.570"></a>
<FONT color="green">571</FONT>             *<a name="line.571"></a>
<FONT color="green">572</FONT>             * @param jcas<a name="line.572"></a>
<FONT color="green">573</FONT>             *            a JCas<a name="line.573"></a>
<FONT color="green">574</FONT>             * @param viewName<a name="line.574"></a>
<FONT color="green">575</FONT>             *            the requested view.<a name="line.575"></a>
<FONT color="green">576</FONT>             * @param create<a name="line.576"></a>
<FONT color="green">577</FONT>             *            the view is created if it does not exist.<a name="line.577"></a>
<FONT color="green">578</FONT>             * @return the requested view<a name="line.578"></a>
<FONT color="green">579</FONT>             * @throws IllegalStateException<a name="line.579"></a>
<FONT color="green">580</FONT>             *             if the JCas wrapper cannot be obtained.<a name="line.580"></a>
<FONT color="green">581</FONT>             */<a name="line.581"></a>
<FONT color="green">582</FONT>            public static JCas getView(JCas jcas, String viewName, boolean create) {<a name="line.582"></a>
<FONT color="green">583</FONT>                    try {<a name="line.583"></a>
<FONT color="green">584</FONT>                            CAS view = CasUtil.getView(jcas.getCas(), viewName, create);<a name="line.584"></a>
<FONT color="green">585</FONT>                            return view != null ? view.getJCas() : null;<a name="line.585"></a>
<FONT color="green">586</FONT>                    }<a name="line.586"></a>
<FONT color="green">587</FONT>                    catch (CASException e) {<a name="line.587"></a>
<FONT color="green">588</FONT>                            throw new IllegalStateException(e);<a name="line.588"></a>
<FONT color="green">589</FONT>                    }<a name="line.589"></a>
<FONT color="green">590</FONT>            }<a name="line.590"></a>
<FONT color="green">591</FONT>    <a name="line.591"></a>
<FONT color="green">592</FONT>            /**<a name="line.592"></a>
<FONT color="green">593</FONT>             * Fetch the text covered by the specified annotations and return it as a list of strings.<a name="line.593"></a>
<FONT color="green">594</FONT>             *<a name="line.594"></a>
<FONT color="green">595</FONT>             * @param &lt;T&gt;<a name="line.595"></a>
<FONT color="green">596</FONT>             *            UIMA JCas type.<a name="line.596"></a>
<FONT color="green">597</FONT>             * @param iterable<a name="line.597"></a>
<FONT color="green">598</FONT>             *            annotation container.<a name="line.598"></a>
<FONT color="green">599</FONT>             * @return list of covered strings.<a name="line.599"></a>
<FONT color="green">600</FONT>             */<a name="line.600"></a>
<FONT color="green">601</FONT>            public static &lt;T extends AnnotationFS&gt; List&lt;String&gt; toText(Iterable&lt;T&gt; iterable) {<a name="line.601"></a>
<FONT color="green">602</FONT>                    return CasUtil.toText(iterable);<a name="line.602"></a>
<FONT color="green">603</FONT>            }<a name="line.603"></a>
<FONT color="green">604</FONT>    <a name="line.604"></a>
<FONT color="green">605</FONT>            @SuppressWarnings({ "cast", "unchecked", "rawtypes" })<a name="line.605"></a>
<FONT color="green">606</FONT>            private static &lt;T&gt; Collection&lt;T&gt; cast(Collection aCollection) {<a name="line.606"></a>
<FONT color="green">607</FONT>                    return (Collection&lt;T&gt;) aCollection;<a name="line.607"></a>
<FONT color="green">608</FONT>            }<a name="line.608"></a>
<FONT color="green">609</FONT>    <a name="line.609"></a>
<FONT color="green">610</FONT>            @SuppressWarnings({ "cast", "unchecked", "rawtypes" })<a name="line.610"></a>
<FONT color="green">611</FONT>            private static &lt;T&gt; List&lt;T&gt; cast(List aCollection) {<a name="line.611"></a>
<FONT color="green">612</FONT>                    return (List&lt;T&gt;) aCollection;<a name="line.612"></a>
<FONT color="green">613</FONT>            }<a name="line.613"></a>
<FONT color="green">614</FONT>    <a name="line.614"></a>
<FONT color="green">615</FONT>            @SuppressWarnings({ "cast", "unchecked", "rawtypes" })<a name="line.615"></a>
<FONT color="green">616</FONT>            private static &lt;K, V&gt; Map&lt;K, V&gt; cast(Map aCollection) {<a name="line.616"></a>
<FONT color="green">617</FONT>                    return (Map&lt;K, V&gt;) aCollection;<a name="line.617"></a>
<FONT color="green">618</FONT>            }<a name="line.618"></a>
<FONT color="green">619</FONT>    }<a name="line.619"></a>




























































</PRE>
</BODY>
</HTML>
